home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / bbs / sfued106.zip / README17.SFU < prev    next >
Text File  |  1992-01-18  |  15KB  |  282 lines

  1.  
  2.               StormFront User Editor for the Opus CBCS
  3.                      Programmed by Kevin Silcox
  4.  
  5.                                                        January 18, 1992
  6.  
  7. Disclaimer
  8. ----------
  9.     This software is available "AS IS".  It is not guaranteed to work at
  10. all. If it trashes your system or ruins your life, you have been warned.
  11. I am not responsible for any damages incurred from the use or misuse of
  12. this software.  There is also no fee to use this software.
  13.  
  14.     You will have to get by without any real documentation until I, or
  15. someone else write some for this program.  If you know Opus and how it
  16. works, then this program should be pretty much self-explanatory as far
  17. as what the actual changes to the user database do.  So for now, there's
  18. only a brief description of how to use the actual functions of the program.
  19. Even though SFUE17 isn't the most user-friendly program, I think that its
  20. flexibility is worth the struggle you may go through when you first start
  21. to use it.  Enjoy!
  22.  
  23. -------------------------------------------------
  24.   This version: 1.06  --->  For Opus v1.7x
  25.   **-- Version numbers with a lowercase letter are beta versions. --**
  26.  
  27.     Requires approximately 100K of Available RAM.  Requires
  28.     more if using the Sort option (based on number of records
  29.     in your database --> about 28 bytes for each record, up to
  30.     a maximum of about 2300 records).
  31.  
  32.     This program is for maintaining the user database used with
  33. Opus.  It is capable of adding users to the USER.DAT file, marking
  34. them to be ReUsed, Purged, Normal, and even Removing users marked
  35. to be Purged (Zap), along with many other features.
  36.  
  37.     The program accepts a command-line argument for local and non-
  38. local use.  The arguments are as follows:
  39.   -M for Mono                           -C for Color
  40.   -D for DOS Output                     -B for BIOS Writes
  41.   -U to specify which User Database     -Z to Zap the database
  42.      file to use.
  43.  
  44.     The -M and -C options are only to force the memory address for the
  45. direct-screen writes if the program doesn't recognize the correct video
  46. mode.  If no arguments are entered, the program will AutoDetect which
  47. video mode to use for the direct-screen writes.  Entering an argument
  48. other than those arguments listed will display a brief help screen.
  49.     The -U allows you to specify the name of the User Database file
  50. that you want to use instead of the default USER.DAT.  If you specify
  51. just the full path without a filename, USER.DAT will be assumed (you
  52. must have a "\" after the path though).
  53.  
  54. *--===--*
  55.     Whenever there has been a modification to the current user record,
  56. SFUE17 will place an asterisk '*' at the top right-hand side of the
  57. screen.  There are two things that SFUE17 *may* change automatically.
  58. If the number of times a user has called the system is zero (0), it will
  59. be changed to one (1).  Also, if the user has QkMenu (Return to Last
  60. Menu) turned on, SFUE17 will try to make sure the menu is valid.
  61.  
  62. **==--==**
  63.     In the lower right-hand corner of the User Screen are the commands
  64. that are available in all ScreenSections.  Below is a brief description
  65. of what they do:
  66.  
  67.     R)  Record Number:  This allows you to go to a specific record number
  68.         within the database.
  69.     !)  User Status:  This allows you to modify the status of a user's
  70.         record.  The Status can be one of the following:
  71.             Normal: This is a normal record.
  72.             Reuse : As new users are added, they will be placed in records
  73.                      marked with this status instead of being added to the
  74.                      end of the database.
  75.             Purge : This means that if you use the Zap function, the record
  76.                      will be removed from the database.  Also used by OMAN.
  77.         Update ID : This will update the caller ID number but should only be
  78.                      used if the caller_ID is all zero's.
  79.     *)  Utilities:   This is for maintaining the database.  These are:
  80.             Adduser: If you need to add a user, this is what you'll use.
  81.                       It has gives you the option of just adding a record
  82.                       at the end of the database, or searching for a record
  83.                       marked with the "Reuse" status.  If you choose to
  84.                       search for a record to Reuse, and there is a record
  85.                       marked with the Reuse status, then that record will be
  86.                       cleared of its information and you may start entering
  87.                       the new user information in that record.
  88.  
  89.             Global : Allows you to make certain changes to specific (or all)
  90.                       users.  You may specify to set only a certain privilege
  91.                       level, or the default is all records (record #1 will
  92.                       NOT be touched).  There are also sub-levels that I
  93.                       don't have time to go into.
  94.                       -=***=-
  95.                       I feel that the options for changing Keys and Sections
  96.                       may cause some confusion.  With those two options there
  97.                       are 4 sub-options [Exact/Set/Toggle/Unselect]:
  98.  
  99.                         Exact:    Set each user to exactly the keys you
  100.                                   specify.  If you only select the 'A' key,
  101.                                   that's the only key the users' will have
  102.                                   no matter what they started out with.
  103.                         Set:      All keys you specify will be turned ON for
  104.                                   each user.
  105.                         Toggle:   Exactly what it says...  If you select the 'A'
  106.                                   key each users' keys will be set to the
  107.                                   opposite it started out as.
  108.                         Unselect: The opposite of Set.  It will make sure each
  109.                                   key you select is turned OFF.
  110.  
  111.             Import : This is if you want to add the users in USER.SAV back into
  112.                       the database.  If successful, USER.SAV will be deleted
  113.                       and a new USER.SAV will be created with a size of zero
  114.                       bytes.  This will allow you to Undelete the old savefile
  115.                       if necessary.
  116.  
  117.             Search : This allows you to search certain fields for a string.
  118.                       It's useful for finding a specific user quickly among
  119.                       other things.
  120.  
  121.             sOrt   : This will sort your database based on the keys you
  122.                       select, and whether you select Ascending or Descending
  123.                       order for each key.  You may select up to two keys to
  124.                       sort by.
  125.                       ** The sort is currently limited to about 1000 records
  126.                          maximum until I get the time to write a different
  127.                          sort routine other than the internal qsort(). **
  128.  
  129.             sWap   : This allows you to swap any two records with each other.
  130.  
  131.             Report : This generates a report for all users and sends it either
  132.                       to the Screen, Printer, or a File.  You can Pause the
  133.                       output by pressing 'P', or have an option to Abort by
  134.                       pressing 'ESC'.  You are asked several questions about
  135.                       how the report should be, but I don't have the time to
  136.                       go into detail explaining it...  However, I will state
  137.                       that SFUE17 will NOT send control codes to the printer,
  138.                       but only format the report appropriately.  Setting your
  139.                       printer into the proper font size and LPI setting is
  140.                       up to you.
  141.  
  142.             Zap    : This removes any records marked with the Purge status.
  143.                       Also you can specify the number of days a user can go
  144.                       without calling the system before he/she is removed from
  145.                       the database.  This option is also available from the
  146.                       command-line.  By default a file called USER.SAV will
  147.                       be used to place any deleted records into.  You may
  148.                       restore the records by using the Import option.
  149.  
  150.   +/-)  Change Record Number:
  151.                      You can use either the plus and minus keys to
  152.                       increment/decrement the record number respectively,
  153.                       or use the right and left arrow keys to do the same
  154.                       thing.  Home and End will place you at the first and
  155.                       last records respectively.
  156.  
  157.   ESC)  Quit:   If you have made any changes to the current record without
  158.                  going to another record, you will be asked if you want to
  159.                  save the user information before exiting.  Anytime you
  160.                  change to another record, the current record is saved to
  161.                  disk if it has been modified.
  162.  
  163. SPACE)  {SpaceBar} ScrnSect:
  164.                 Changes the current Screen Section.  The active ScrnSect is
  165.                  displayed at the top of the screen.  The Screen Sections are
  166.                  at the left side of each box border.  A ScrnSect must be
  167.                  active in order for its commands to be active.  Also when a
  168.                  ScrnSect is active, the number next to the active box will
  169.                  BLINK.
  170.                 The ScrnSect can also be changed with the up and down arrow
  171.                  keys to decrement/increment the ScrnSect number respectively.
  172.  
  173.    F9)  DOS Shell:  Exactly what it says.  The User Editor is NOT swapped
  174.                      out of memory.
  175. **==--==**
  176.  
  177.     I hope this is enough of a program description to get you familiar with
  178. the program.  For Opus v1.7x the ScrnSect is not the same as the "Section" in
  179. Opus.
  180.     Currently this Editor doesn't contain an internal index updating function.
  181. You will need to use the USERNDX program that is distributed with Opus v1.7x.
  182. The Editor will call USERNDX when exiting whenever it thinks the Index needs
  183. to be updated.  USERNDX will only be called when you have made changes inside
  184. the Editor that might change the NDX file.  USERNDX must either be located in
  185. the PATH, or in the same directory as your user database, or in your Opus Home
  186. Directory.
  187. ------------------------------------------------------
  188.  
  189. ***********************
  190. * Report Information: *
  191. ***********************
  192.  
  193. **
  194. Level of Detail Grouping (80-column output):
  195. ------------------------------------------------------
  196. 1:
  197.  A = User Record Number                 (Width =  5)
  198.  B = User Name                          (Width = 26)
  199.  C = Phone Number                       (Width = 15)
  200.  D = City, State                        (Width = 25)
  201. --
  202. 2:
  203.  E = Street Address                     (Width = 26)
  204.  F = Answer to SysOp Question           (Width = 43)
  205. --
  206. 3:
  207.  G = SysOp Comment                      (Width = 44)
  208.  H = Birthdate                          (Width =  9)
  209.  I = Access Privilege                   (Width =  9)
  210. --
  211. 4:
  212.  J = Keys                               (Width = 32)
  213.  K = Download:Upload Ratio              (Width =  9)
  214.  L = Days Since Last Call               (Width =  4)
  215.  M = Password (optional)                (Width = 15)
  216.  
  217. ------------------------------------------------------
  218.  
  219. **
  220. Level of Detail Grouping (132-column output):
  221. ------------------------------------------------------
  222. 1:
  223.  A = User Record Number                 (Width =  5)
  224.  B = User Name                          (Width = 26)
  225.  C = Phone Number                       (Width = 15)
  226.  D = City, State                        (Width = 25)
  227.  E = Street Address                     (Width = 25)
  228.  F = Alias                              (Width = 20)
  229. --
  230. 2:
  231.  G = Answer to SysOp Question           (Width = 44)
  232.  H = SysOp Comment                      (Width = 45)
  233.  I = Birthdate                          (Width =  9)
  234.  J = Password (optional)                (Width = 15)
  235. --
  236. 3:
  237.  K = Access Privilege                   (Width =  9)
  238.  L = Keys                               (Width = 32)
  239.  M = Download:Upload Ratio              (Width =  9)
  240.  N = Days Since Last Call               (Width =  4)
  241.  O = First Call to System               (Width = 11)
  242.  
  243. ------------------------------------------------------
  244.  
  245.  
  246. ------------------------------------------------------
  247.  
  248.     Thank You for taking your time to read this, and use my program.
  249. If you have any comments or suggestions, I'd like to hear from you.
  250. Please contact me if you have any problems with the program, or you
  251. would like to see any added features.  You may contact me (via NetMail)
  252. at the phone number (or FidoNet Address) listed below.  I also read the
  253. NEWOPUS and MEADOW Echo's.  The latest version of my software is also
  254. available on my BBS.  It may be requested with the magic name of "SFUE17"
  255. for the Opus 1.7x version, and "SFUE11" for the Opus 1.1x version.
  256.  
  257.                                 --=={ Kevin Silcox ------
  258.                                 SysOp of:
  259.                                     The StormFront BBS
  260.                                     in Orangevale, California
  261.                                     (916) 988-0407
  262.                                     FidoNet (1:203/407.0)
  263.  
  264.                                 BBS Hours:
  265.                                     Conditionally 23 hours a day,
  266.                                       but definately between:
  267.                                       11:00 p.m. and 11:00 a.m
  268.                                     excluding National Mail Hour:
  269.                                       1:00 a.m to 2:00 a.m PST
  270.  
  271.     Since this phone number is also my voice number for now, there may
  272. be times when I pick up the phone instead of the computer.  If this
  273. happens I'll immediately try to force the BBS to answer the phone so
  274. you don't have to call back.  I'll try to make the line busy whenever
  275. I'm doing something on the computer that would prevent me from forcing
  276. the BBS to answer.  Have fun!
  277.  
  278.     Special Thanks to my Beta Test Team for making suggestions that
  279. have increased the power (and flexibility) of SFUE17, and especially
  280. for finding those little critters that lurk around in most software!
  281.  
  282.